<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>Module erlang-dbus-client</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>

<h1>Module erlang-dbus-client</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
  <h3><a name="Messages_Generated">Messages Generated</a></h3>.


<h2><a name="description">Description</a></h2>
  <h3><a name="Messages_Generated">Messages Generated</a></h3>
 
  <p>The following messages are generated back to the Client.</p>
 
 	<p>An error occured:</p>
 
 	<pre>     {edbus, {error, Reason}}</pre>
 
 	<p>The Client interface is ready to be used:</p>
 
 	<pre>     {edbus, {ready, UName}}</pre>
 
   <p>The Client attempted to use the interface prematurely:</p>
 
 	<pre>     {edbus, {error, 'interface.not.ready'}}</pre>
 
 
<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#init-0">init/0</a></td><td>Initializes the Client Interface.</td></tr>
<tr><td valign="top"><a href="#init-1">init/1</a></td><td>Initializes the Client Interface in debug mode.</td></tr>
<tr><td valign="top"><a href="#register_name-1">register_name/1</a></td><td>Registers a "Name" with DBus.</td></tr>
<tr><td valign="top"><a href="#send_error-1">send_error/1</a></td><td>Sends a "Error" message.</td></tr>
<tr><td valign="top"><a href="#send_method-1">send_method/1</a></td><td>Sends a "Method Call" message.</td></tr>
<tr><td valign="top"><a href="#send_return-1">send_return/1</a></td><td>Sends a "Method Return" message.</td></tr>
<tr><td valign="top"><a href="#send_signal-1">send_signal/1</a></td><td>Sends a "Signal" message.</td></tr>
<tr><td valign="top"><a href="#subscribe_signals-1">subscribe_signals/1</a></td><td>Subscribe a Client to a list of Signals.</td></tr>
</table>

<h2><a name="functions">Function Details</a></h2>

<h3 class="function"><a name="init-0">init/0</a></h3>
<div class="spec">
<p><tt>init() -&gt; ok | {error, Reason}</tt></p>
</div><p>Initializes the Client Interface
 </p>

<h3 class="function"><a name="init-1">init/1</a></h3>
<div class="spec">
<p><tt>init(X1::debug) -&gt; ok | {error, Reason}</tt></p>
</div><p>Initializes the Client Interface in debug mode
 </p>

<h3 class="function"><a name="register_name-1">register_name/1</a></h3>
<div class="spec">
<p><tt>register_name(Name) -&gt; ok | {error, Reason}</tt>
<ul class="definitions"><li><tt>Name = string()</tt></li>
</ul></p>
</div><p>Registers a "Name" with DBus
 </p>

<h3 class="function"><a name="send_error-1">send_error/1</a></h3>
<div class="spec">
<p><tt>send_error(X1::{Serial, Destination, Name, Message}) -&gt; ok | {error, Reason}</tt>
<ul class="definitions"><li><tt>Serial = integer()</tt></li>
<li><tt>Destination = string()</tt></li>
<li><tt>Name = string()</tt></li>
<li><tt>Message = term()</tt></li>
</ul></p>
</div><p><p>Sends a "Error" message</p>
 
 	Note that the 'Serial' parameter is unused at present.
 </p>

<h3 class="function"><a name="send_method-1">send_method/1</a></h3>
<div class="spec">
<p><tt>send_method(X1::{Serial, Destination, Path, Interface, Member, Message}) -&gt; ok | {error, Reason}</tt>
<ul class="definitions"><li><tt>Serial = integer()</tt></li>
<li><tt>Destination = string()</tt></li>
<li><tt>Path = string()</tt></li>
<li><tt>Interface = string()</tt></li>
<li><tt>Member = string()</tt></li>
<li><tt>Message = term()</tt></li>
</ul></p>
</div><p><p>Sends a "Method Call" message</p>
 
 	Note that the 'Serial' parameter is unused at present.
 </p>

<h3 class="function"><a name="send_return-1">send_return/1</a></h3>
<div class="spec">
<p><tt>send_return(X1::{Serial, Destination, Message}) -&gt; ok | {error, Reason}</tt>
<ul class="definitions"><li><tt>Serial = integer()</tt></li>
<li><tt>Destination = string()</tt></li>
<li><tt>Message = term()</tt></li>
</ul></p>
</div><p><p>Sends a "Method Return" message</p>
 
 	Note that the 'Serial' parameter is unused at present.
 </p>

<h3 class="function"><a name="send_signal-1">send_signal/1</a></h3>
<div class="spec">
<p><tt>send_signal(X1::{Serial, Destination, Path, Interface, Member, Message}) -&gt; ok | {error, Reason}</tt>
<ul class="definitions"><li><tt>Serial = integer()</tt></li>
<li><tt>Destination = string()</tt></li>
<li><tt>Path = string()</tt></li>
<li><tt>Interface = string()</tt></li>
<li><tt>Member = string()</tt></li>
<li><tt>Message = term()</tt></li>
</ul></p>
</div><p><p>Sends a "Signal" message</p>
 
 	Note that the 'Serial' parameter is unused at present.
 </p>

<h3 class="function"><a name="subscribe_signals-1">subscribe_signals/1</a></h3>
<div class="spec">
<p><tt>subscribe_signals(List) -&gt; ok | {error, Reason}</tt>
<ul class="definitions"><li><tt>List = [string()]</tt></li>
</ul></p>
</div><p><p>Subscribe a Client to a list of Signals</p>
 
 		The subscription is based on the match rule
 		on the 'interface' parameter i.e. the Client
 		is subscribed to all signals sent on the
 		list of supplied interfaces.
 </p>
<hr>

<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Nov 19 2009, 11:42:30.</i></p>
</body>
</html>
